feat(edge-proxy): Wire the flagsmith-private edge_control_plane app into the api by gagantrivedi · Pull Request #8305 · Flagsmith/flagsmith

gagantrivedi · 2026-08-15T10:34:20Z

Thanks for submitting a PR! Please check the boxes below:

I have read the Contributing Guide.
I have added information to docs/ if required so people know about the feature.
I have filled in the "Changes" section below.
I have filled in the "How did you test this code" section below.

Changes

Wires up the edge_control_plane private app (Flagsmith/flagsmith-private#265, renamed in #285, released in flagsmith-private 0.14.0, which main already locks via #8540). It provides the proxy key credential, the proxy config endpoint that lets a running Edge Proxy discover its environments, and the usage ingestion endpoint. Consumed by the proxy in Flagsmith/edge-proxy-rs#17, #18 and #19.

Three edits, following the rbac/scim pattern:

EDGE_CONTROL_PLANE_INSTALLED detection and conditional INSTALLED_APPS append.
Mounts for the two URL trees: proxy key management under organisations/{id}/edge-proxy/, and api/v1/proxy/ for the config and usage endpoints.
A mypy override so the no-private run passes.

Private cloud only: SaaS images ship the private wheel, so the mounts are gated on is_saas() at runtime rather than on the app being absent; the app's own views carry a matching permission as defence in depth.

How did you test this code?

With the 0.14.0 app installed: EDGE_CONTROL_PLANE_INSTALLED is True, edge_control_plane is in INSTALLED_APPS, and the three routes resolve (/api/v1/proxy/config/, /api/v1/proxy/usage/, /api/v1/organisations/1/edge-proxy/keys/). With a SAAS_DEPLOYMENT marker file present they 404. The app's own behaviour is covered by the integration tests in flagsmith-private.

vercel · 2026-08-15T10:34:26Z

The latest updates on your projects. Learn more about Vercel for GitHub.

3 Skipped Deployments

Project	Deployment	Actions	Updated
docs	Ignored	Preview	Sep 16, 2026 10:23am UTC
flagsmith-frontend-preview	Ignored	Preview	Sep 16, 2026 10:23am UTC
flagsmith-frontend-staging	Ignored	Preview	Sep 16, 2026 10:23am UTC

coderabbitai · 2026-08-15T10:34:30Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 3f189e48-95c6-4891-a522-4b2d3efa6a15

📥 Commits

Reviewing files that changed from the base of the PR and between 4330617 and 8732a97.

📒 Files selected for processing (4)

api/app/settings/common.py
api/app/urls.py
api/pyproject.toml
openapi.yaml

Included review availability: Your plan provides up to 8 included reviews per hour; 7 remain after this review.

📝 Walkthrough

Walkthrough

The change detects the optional edge_control_plane module and adds it to Django when available. It registers Edge Proxy routes when the module is installed and the runtime is not SaaS. It configures mypy for missing edge_control_plane imports. The OpenAPI specification adds Edge Proxy key CRUD endpoints, proxy configuration and usage endpoints, and related schemas.

Priority: ➖ Normal

Estimated code review effort: 3 (Moderate) | ~25 minutes

Merge Risk: ⚪ Minimal · up to 8732a

The optional Edge Proxy integration and API definitions have no verified merge-blocking issue in the available code.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

codecov · 2026-08-15T10:41:25Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.81%. Comparing base (2b5fa4e) to head (8732a97).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #8305   +/-   ##
=======================================
  Coverage   98.81%   98.81%           
=======================================
  Files        1620     1620           
  Lines       66185    66186    +1     
=======================================
+ Hits        65400    65401    +1     
  Misses        785      785

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

github-actions · 2026-08-29T05:23:12Z

Docker builds report

Image	Build Status	Security report
`ghcr.io/flagsmith/flagsmith-e2e:pr-8305`	Finished ✅	Skipped
`ghcr.io/flagsmith/flagsmith-frontend:pr-8305`	Finished ✅	Results ✅
`ghcr.io/flagsmith/flagsmith-api-test:pr-8305`	Finished ✅	Skipped
`ghcr.io/flagsmith/flagsmith-api:pr-8305`	Finished ✅	Results ✅
`ghcr.io/flagsmith/flagsmith:pr-8305`	Finished ✅	Results ✅
`ghcr.io/flagsmith/flagsmith-private-cloud:pr-8305`	Finished ✅	Results ✅

github-actions · 2026-08-29T05:28:04Z

✅ private-cloud · depot-ubuntu-latest-16 — run #20483 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

2 passed

Details

2 tests across 2 suites
48.2 seconds
2b4b6f4
🔄 Run: #20483 (attempt 1)

🗂️ Previous results

✅ private-cloud · depot-ubuntu-latest-arm-16 — run #20483 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

2 passed

Details

2 tests across 2 suites
59.2 seconds
2b4b6f4
🔄 Run: #20483 (attempt 1)

✅ oss · depot-ubuntu-latest-arm-16 — run #20484 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

1 passed

Details

1 test across 1 suite
41.5 seconds
8732a97
🔄 Run: #20484 (attempt 1)

✅ oss · depot-ubuntu-latest-arm-16 — run #20483 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

1 passed

Details

1 test across 1 suite
41.6 seconds
2b4b6f4
🔄 Run: #20483 (attempt 1)

✅ oss · depot-ubuntu-latest-16 — run #20483 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-16)

1 passed

Details

1 test across 1 suite
33.2 seconds
2b4b6f4
🔄 Run: #20483 (attempt 1)

✅ oss · depot-ubuntu-latest-16 — run #20484 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-16)

2 passed

Details

2 tests across 2 suites
3.5 seconds
8732a97
🔄 Run: #20484 (attempt 1)

✅ private-cloud · depot-ubuntu-latest-16 — run #19945 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

2 passed

Details

2 tests across 2 suites
48.8 seconds
4330617
🔄 Run: #19945 (attempt 1)

✅ private-cloud · depot-ubuntu-latest-arm-16 — run #19945 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

3 passed

Details

3 tests across 3 suites
38.7 seconds
4330617
🔄 Run: #19945 (attempt 1)

✅ oss · depot-ubuntu-latest-arm-16 — run #19945 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

1 passed

Details

1 test across 1 suite
47.7 seconds
4330617
🔄 Run: #19945 (attempt 1)

✅ oss · depot-ubuntu-latest-16 — run #19945 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-16)

1 passed

Details

1 test across 1 suite
41.1 seconds
4330617
🔄 Run: #19945 (attempt 1)

✅ private-cloud · depot-ubuntu-latest-arm-16 — run #19943 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

2 passed

Details

2 tests across 2 suites
38.1 seconds
eb468cc
🔄 Run: #19943 (attempt 1)

✅ private-cloud · depot-ubuntu-latest-16 — run #19943 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

2 passed

Details

2 tests across 2 suites
31.9 seconds
eb468cc
🔄 Run: #19943 (attempt 1)

github-actions · 2026-08-29T05:28:49Z

Visual Regression

19 screenshots compared. See report for details.
View full report

Installs the app when the flagsmith-private wheel provides it, and mounts its two URL trees outside SaaS: proxy key management under organisations/{id}/edge-proxy/ and the proxy endpoints under api/v1/proxy/.

github-actions Bot added api Issue related to the REST API feature New feature or request labels Aug 15, 2026

gagantrivedi force-pushed the feat/edge-proxy-app-wiring branch from 42c4d60 to eb468cc Compare August 29, 2026 05:22

github-actions Bot added feature New feature or request and removed feature New feature or request labels Aug 29, 2026

gagantrivedi changed the title ~~feat: wire up the edge_proxy private app~~ feat(edge-proxy): Wire the flagsmith-private edge_proxy app into the api Aug 29, 2026

gagantrivedi marked this pull request as ready for review August 29, 2026 05:22

gagantrivedi requested a review from a team as a code owner August 29, 2026 05:22

gagantrivedi requested review from matthewelwell and removed request for a team August 29, 2026 05:22

github-actions Bot removed the feature New feature or request label Aug 29, 2026

github-actions Bot added the feature New feature or request label Aug 29, 2026

flagsmith-engineering Bot requested a review from a team as a code owner August 29, 2026 05:23

gagantrivedi force-pushed the feat/edge-proxy-app-wiring branch from 247cfc9 to 4330617 Compare August 29, 2026 05:28

github-actions Bot added feature New feature or request and removed feature New feature or request labels Aug 29, 2026

This was referenced Aug 29, 2026

feat: Exclude verified Edge Proxy requests from API usage tracking #8407

Draft

feat: Report served-request usage Flagsmith/edge-proxy-rs#19

Open

matthewelwell reviewed Sep 2, 2026

View reviewed changes

Comment thread api/app/settings/common.py Outdated

feat: wire up the edge_control_plane private app

2b4b6f4

Installs the app when the flagsmith-private wheel provides it, and mounts its two URL trees outside SaaS: proxy key management under organisations/{id}/edge-proxy/ and the proxy endpoints under api/v1/proxy/.

gagantrivedi force-pushed the feat/edge-proxy-app-wiring branch from 4330617 to 2b4b6f4 Compare September 16, 2026 10:21

gagantrivedi changed the title ~~feat(edge-proxy): Wire the flagsmith-private edge_proxy app into the api~~ feat(edge-proxy): Wire the flagsmith-private edge_control_plane app into the api Sep 16, 2026

github-actions Bot added feature New feature or request and removed feature New feature or request labels Sep 16, 2026

chore: Update documentation artefacts

8732a97

matthewelwell approved these changes Sep 16, 2026

View reviewed changes

gagantrivedi merged commit 5b54de7 into main Sep 16, 2026
38 of 42 checks passed

gagantrivedi deleted the feat/edge-proxy-app-wiring branch September 16, 2026 11:12

flagsmith-engineering Bot mentioned this pull request Sep 16, 2026

chore(main): release 2.273.0 #8539

Merged

Conversation

gagantrivedi commented Aug 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

How did you test this code?

Uh oh!

vercel Bot commented Aug 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Aug 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Uh oh!

codecov Bot commented Aug 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions Bot commented Aug 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Docker builds report

Uh oh!

github-actions Bot commented Aug 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

Details

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

Details

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

Details

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

Details

Playwright Test Results (oss - depot-ubuntu-latest-16)

Details

Playwright Test Results (oss - depot-ubuntu-latest-16)

Details

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

Details

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

Details

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

Details

Playwright Test Results (oss - depot-ubuntu-latest-16)

Details

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

Details

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

Details

Uh oh!

github-actions Bot commented Aug 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Visual Regression

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

gagantrivedi commented Aug 15, 2026 •

edited

Loading

vercel Bot commented Aug 15, 2026 •

edited

Loading

coderabbitai Bot commented Aug 15, 2026 •

edited

Loading

codecov Bot commented Aug 15, 2026 •

edited

Loading

github-actions Bot commented Aug 29, 2026 •

edited

Loading

github-actions Bot commented Aug 29, 2026 •

edited

Loading

github-actions Bot commented Aug 29, 2026 •

edited

Loading